#!/usr/bin/env python
"""决策树."""


from math import log
import operator
from matplotlib.font_manager import FontProperties
import matplotlib.pyplot as plt


def main():
    """主函数."""
    dataSet, labels = createDataSet()
    featLabels = []
    myTree = createTree(dataSet, labels, featLabels)
    createPlot(myTree)


def calcShannonEnt(dataSet):
    """
    函数说明：计算给定数据集的经验熵（香农熵）.

    Parameters：
        dataSet：数据集
    Returns：
        shannonEnt：经验熵
    Modify：
        2018-03-12

    """
    # 返回数据集行数,即样本数量
    numEntries = len(dataSet)
    # 保存每个标签（label）出现次数的字典
    labelCounts = {}
    # 对每组特征向量进行统计
    for featVec in dataSet:
        currentLabel = featVec[-1]  # 提取标签信息,最后一列数据，即响应变量的值,返回int类型
        if currentLabel not in labelCounts.keys():  # 如果标签没有放入统计次数的字典，添加进去
            labelCounts[currentLabel] = 0
        labelCounts[currentLabel] += 1  # label计数

    shannonEnt = 0.0  # 经验熵
    # 计算经验熵
    for key in labelCounts:
        # 选择该标签的概率,labelCounts[key]是引用key对应的value值
        prob = float(labelCounts[key]) / numEntries
        shannonEnt -= prob * log(prob, 2)  # 利用公式计算
    return shannonEnt  # 返回经验熵


def createDataSet():
    """
    函数说明：创建测试数据集.

    Parameters：无
    Returns：
        dataSet：数据集
        labels：分类属性
    Modify：
        2018-03-13

    """
    # 数据集
    dataSet = [[0, 0, 0, 0, 'no'],
               [0, 0, 0, 1, 'no'],
               [0, 1, 0, 1, 'yes'],
               [0, 1, 1, 0, 'yes'],
               [0, 0, 0, 0, 'no'],
               [1, 0, 0, 0, 'no'],
               [1, 0, 0, 1, 'no'],
               [1, 1, 1, 1, 'yes'],
               [1, 0, 1, 2, 'yes'],
               [1, 0, 1, 2, 'yes'],
               [2, 0, 1, 2, 'yes'],
               [2, 0, 1, 1, 'yes'],
               [2, 1, 0, 1, 'yes'],
               [2, 1, 0, 2, 'yes'],
               [2, 0, 0, 0, 'no']]
    # 分类属性
    labels = ['年龄', '有工作', '有自己的房子', '信贷情况']
    # 返回数据集和分类属性
    return dataSet, labels


def splitDataSet(dataSet, axis, value):
    """
    函数说明：按照给定特征划分数据集.

    Parameters：
        dataSet:待划分的数据集
        axis：划分数据集的特征
        value：需要返回的特征值
    Returns：
        无
    Modify：
        2018-03-13

    """
    # 创建返回的数据集列表
    retDataSet = []
    # 遍历数据集
    for featVec in dataSet:
        if featVec[axis] == value:
            # 去掉axis特征
            reduceFeatVec = featVec[:axis]
            # 将符合条件的添加到返回的数据集
            # 将每一行的featVec[axis + 1:]的特征加到reduceFeatVec后面
            reduceFeatVec.extend(featVec[axis + 1:])
            # 每一行去掉后加到retDataSet列表，相当于删除了第axis列的所有元素
            retDataSet.append(reduceFeatVec)
    # 返回划分后的数据集
    return retDataSet


def chooseBestFeatureToSplit(dataSet):
    """
    函数说明：计算给定数据集的经验熵（香农熵）.

    Parameters：
        dataSet：数据集
    Returns：
        shannonEnt：信息增益最大特征的索引值
    Modify：
        2018-03-13

    """
    # 特征数量(除去最后一行响应变量）
    numFeatures = len(dataSet[0]) - 1
    # 计数数据集的香农熵（响应变量的香农熵）
    baseEntropy = calcShannonEnt(dataSet)  # 响应变量的香农熵
    # 信息增益
    bestInfoGain = 0.0
    # 最优特征的索引值
    bestFeature = -1
    # 遍历所有特征
    for i in range(numFeatures):
        # 获取dataSet的第i个所有特征值
        featList = [example[i] for example in dataSet]
        # 创建set集合{}，元素不可重复，方便统计值为featList[i]的数量
        uniqueVals = set(featList)
        # 经验条件熵
        newEntropy = 0.0
        # 计算信息增益
        for value in uniqueVals:
            # subDataSet划分后的子集——删除了第i列
            subDataSet = splitDataSet(dataSet, i, value)
            ''''# print(subDataSet)
            # print(len(subDataSet))
            # print(type(subDataSet))
            疑问：上述第一个print()输出含有15个元素的列表，
            但是第二个print()结果为5——事实上这个结果应该是len(set(subDataSet))的结果'''

            # 计算子集的概率
            prob = len(subDataSet) / float(len(dataSet))
            # print(prob,'\n')
            # 根据公式计算经验条件熵
            newEntropy += prob * calcShannonEnt((subDataSet))
        # 信息增益
        infoGain = baseEntropy - newEntropy
        # 打印每个特征的信息增益
        print("第%d个特征的增益为%.3f" % (i, infoGain))
        # 计算信息增益
        if (infoGain > bestInfoGain):
            # 更新信息增益，找到最大的信息增益
            bestInfoGain = infoGain
            # 记录信息增益最大的特征的索引值
            bestFeature = i
            # 返回信息增益最大特征的索引值
    return bestFeature


def majorityCnt(classList):
    """
    函数说明：统计classList中出现次数最多的元素（类标签）.

    Parameters：
        classList：类标签列表
    Returns：
        sortedClassCount[0][0]：出现次数最多的元素（类标签）
    Modify：
        2018-03-13

    """
    classCount = {}
    # 统计classList中每个元素出现的次数
    for vote in classList:
        if vote not in classCount.keys():
            classCount[vote] = 0
            classCount[vote] += 1
        # 根据字典的值降序排列
        sortedClassCount = sorted(classCount.items(),
                                  key=operator.itemgetter(1),
                                  reverse=True)
        return sortedClassCount[0][0]


def createTree(dataSet, labels, featLabels):
    """
    函数说明：创建决策树.

    Parameters:
        dataSet：训练数据集
        labels：分类属性标签
        featLabels：存储选择的最优特征标签
    Returns:
        myTree：决策树
    Modify:
        2018-03-13

    """
    # 取分类标签（是否放贷：yes or no）
    classList = [example[-1] for example in dataSet]
    # 如果类别完全相同——响应变量全部相同，则停止继续划分
    if classList.count(classList[0]) == len(classList):
        return classList[0]
    # 遍历完所有特征时返回出现次数最多的类标签
    if len(dataSet[0]) == 1:  # 只有一个响应变量，没有类可分了
        return majorityCnt(classList)
    # 选择最优特征
    bestFeat = chooseBestFeatureToSplit(dataSet)
    # 最优特征的标签
    bestFeatLabel = labels[bestFeat]
    featLabels.append(bestFeatLabel)
    # 根据最优特征的标签生成树
    myTree = {bestFeatLabel: {}}
    # 删除已经使用的特征标签
    del (labels[bestFeat])
    # 得到训练集中所有最优特征的属性值
    featValues = [example[bestFeat] for example in dataSet]
    # 去掉重复的属性值
    uniqueVls = set(featValues)
    # 遍历特征，创建决策树
    for value in uniqueVls:
        myTree[bestFeatLabel][value] = createTree(
            splitDataSet(dataSet, bestFeat, value),
            labels, featLabels)
    return myTree


def getNumLeafs(myTree):
    """
    函数说明：获取决策树叶子节点的数目.

    Parameters：
        myTree：决策树
    Returns：
        numLeafs：决策树的叶子节点的数目
    Modify：
        2018-03-13

    """
    numLeafs = 0
    firstStr = next(iter(myTree))
    secondDict = myTree[firstStr]
    for key in secondDict.keys():
        if type(secondDict[key]).__name__ == 'dict':
            numLeafs += getNumLeafs(secondDict[key])
        else:
            numLeafs += 1
    return numLeafs


def getTreeDepth(myTree):
    """
    函数说明:获取决策树的层数.

    Parameters:
        myTree:决策树
    Returns:
        maxDepth:决策树的层数

    Modify:
        2018-03-13
    """
    maxDepth = 0  # 初始化决策树深度
    # python3中myTree.keys()返回的是dict_keys,不在是list,所以不能使用myTree.keys()[0]的方法获取结点属性，可以使用list(myTree.keys())[0]
    firstStr = next(iter(myTree))
    secondDict = myTree[firstStr]  # 获取下一个字典
    for key in secondDict.keys():
        # 测试该结点是否为字典，如果不是字典，代表此结点为叶子结点
        if type(secondDict[key]).__name__ == 'dict':
            thisDepth = 1 + getTreeDepth(secondDict[key])
        else:
            thisDepth = 1
        # 更新层数
        if thisDepth > maxDepth:
            maxDepth = thisDepth
    return maxDepth


def plotNode(nodeTxt, centerPt, parentPt, nodeType):
    """
    函数说明:绘制结点.

    Parameters:
        nodeTxt - 结点名
        centerPt - 文本位置
        parentPt - 标注的箭头位置
        nodeType - 结点格式
    Returns:
        无
    Modify:
        2018-03-13
    """
    arrow_args = dict(arrowstyle="<-")  # 定义箭头格式
    # 设置中文字体
    font = FontProperties(
        fname=r"/usr/share/fonts/winfonts/STSONG.TTF", size=14)
    # 绘制结点
    createPlot.ax1.annotate(nodeTxt, xy=parentPt, xycoords='axes fraction',
                            xytext=centerPt, textcoords='axes fraction',
                            va="center", ha="center", bbox=nodeType,
                            arrowprops=arrow_args, fontproperties=font)


def plotMidText(cntrPt, parentPt, txtString):
    """
    函数说明:标注有向边属性值.

    Parameters:
        cntrPt、parentPt - 用于计算标注位置
        txtString - 标注的内容
    Returns:
        无
    Modify:
        2018-03-13
    """
    xMid = (parentPt[0] - cntrPt[0]) / 2.0 + cntrPt[0]  # 计算标注位置
    yMid = (parentPt[1] - cntrPt[1]) / 2.0 + cntrPt[1]
    createPlot.ax1.text(xMid, yMid, txtString, va="center",
                        ha="center", rotation=30)


def plotTree(myTree, parentPt, nodeTxt):
    """
    函数说明:绘制决策树.

    Parameters:
        myTree - 决策树(字典)
        parentPt - 标注的内容
        nodeTxt - 结点名
    Returns:
        无
    Modify:
        2018-03-13
    """
    decisionNode = dict(boxstyle="sawtooth", fc="0.8")  # 设置结点格式
    leafNode = dict(boxstyle="round4", fc="0.8")  # 设置叶结点格式
    numLeafs = getNumLeafs(myTree)  # 获取决策树叶结点数目，决定了树的宽度
    firstStr = next(iter(myTree))  # 下个字典
    cntrPt = (plotTree.xOff + (1.0 + float(numLeafs)) / 2.0 / plotTree.totalW,
              plotTree.yOff)  # 中心位置
    plotMidText(cntrPt, parentPt, nodeTxt)  # 标注有向边属性值
    plotNode(firstStr, cntrPt, parentPt, decisionNode)  # 绘制结点
    secondDict = myTree[firstStr]  # 下一个字典，也就是继续绘制子结点
    plotTree.yOff = plotTree.yOff - 1.0 / plotTree.totalD  # y偏移
    for key in secondDict.keys():
        # 测试该结点是否为字典，如果不是字典，代表此结点为叶子结点
        if type(secondDict[key]).__name__ == 'dict':
            plotTree(secondDict[key], cntrPt, str(key))  # 不是叶结点，递归调用继续绘制
        else:  # 如果是叶结点，绘制叶结点，并标注有向边属性值
            plotTree.xOff = plotTree.xOff + 1.0 / plotTree.totalW
            plotNode(secondDict[key], (plotTree.xOff, plotTree.yOff),
                     cntrPt, leafNode)
            plotMidText((plotTree.xOff, plotTree.yOff), cntrPt, str(key))
    plotTree.yOff = plotTree.yOff + 1.0 / plotTree.totalD


def createPlot(inTree):
    """
    函数说明:创建绘制面板.

    Parameters:
        inTree - 决策树(字典)
    Returns:
        无
    Modify:
        2018-03-13
    """
    fig = plt.figure(1, facecolor='white')  # 创建fig
    fig.clf()  # 清空fig
    axprops = dict(xticks=[], yticks=[])
    createPlot.ax1 = plt.subplot(111, frameon=False, **axprops)  # 去掉x、y轴
    plotTree.totalW = float(getNumLeafs(inTree))  # 获取决策树叶结点数目
    plotTree.totalD = float(getTreeDepth(inTree))  # 获取决策树层数
    plotTree.xOff = -0.5 / plotTree.totalW
    plotTree.yOff = 1.0  # x偏移
    plotTree(inTree, (0.5, 1.0), '')  # 绘制决策树
    plt.show()  # 显示绘制结果


if "__main__" == __name__:
    main()
